﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class Biasing.IterationSimulationState
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class Biasing.IterationSimulationState
   ">
    <meta name="generator" content="docfx 2.52.0.0">
    
    <link rel="shortcut icon" href="../api/images/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
    
    
    
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState">
  
  
  <h1 id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState" class="text-break">Class Biasing.IterationSimulationState
  </h1>
  <div class="markdown level0 summary"><p>An <a class="xref" href="SpiceSharp.Simulations.IIterationSimulationState.html">IIterationSimulationState</a> that allows concurrent access.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">Biasing.IterationSimulationState</span></div>
  </div>
  <div classs="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="SpiceSharp.Simulations.IIterationSimulationState.html">IIterationSimulationState</a></div>
    <div><a class="xref" href="SpiceSharp.Simulations.ISimulationState.html">ISimulationState</a></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <span class="xref">System.Object.ToString()</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="SpiceSharp.Components.ParallelComponents.html">SpiceSharp.Components.ParallelComponents</a></h6>
  <h6><strong>Assembly</strong>: SpiceSharp.dll</h6>
  <h5 id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">protected class IterationSimulationState : IIterationSimulationState, ISimulationState</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  <a id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState__ctor_" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.#ctor*"></a>
  <h4 id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState__ctor_SpiceSharp_Simulations_IIterationSimulationState_" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.#ctor(SpiceSharp.Simulations.IIterationSimulationState)">IterationSimulationState(IIterationSimulationState)</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.html">Biasing.IterationSimulationState</a> class.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IterationSimulationState(IIterationSimulationState parent)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IIterationSimulationState.html">IIterationSimulationState</a></td>
        <td><span class="parametername">parent</span></td>
        <td><p>The parent.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="exceptions">Exceptions</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Condition</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.ArgumentNullException</span></td>
        <td><p>Thrown if <code data-dev-comment-type="paramref" class="paramref">parent</code> is <code>null</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="eii">Explicit Interface Implementations
  </h3>
  <a id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_SpiceSharp_Simulations_IIterationSimulationState_Gmin_" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.SpiceSharp#Simulations#IIterationSimulationState#Gmin*"></a>
  <h4 id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_SpiceSharp_Simulations_IIterationSimulationState_Gmin" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.SpiceSharp#Simulations#IIterationSimulationState#Gmin">IIterationSimulationState.Gmin</h4>
  <div class="markdown level1 summary"><p>Gets or sets the a conductance that is shunted with PN junctions to aid convergence.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">double IIterationSimulationState.Gmin { get; }</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The minimum conductance for PN junctions.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_SpiceSharp_Simulations_IIterationSimulationState_IsConvergent_" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.SpiceSharp#Simulations#IIterationSimulationState#IsConvergent*"></a>
  <h4 id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_SpiceSharp_Simulations_IIterationSimulationState_IsConvergent" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.SpiceSharp#Simulations#IIterationSimulationState#IsConvergent">IIterationSimulationState.IsConvergent</h4>
  <div class="markdown level1 summary"><p>Is the current iteration convergent?
This parameter is used to communicate convergence.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">bool IIterationSimulationState.IsConvergent { get; set; }</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p><code>true</code> if this the iteration is convergent; otherwise, <code>false</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_SpiceSharp_Simulations_IIterationSimulationState_Mode_" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.SpiceSharp#Simulations#IIterationSimulationState#Mode*"></a>
  <h4 id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_SpiceSharp_Simulations_IIterationSimulationState_Mode" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.SpiceSharp#Simulations#IIterationSimulationState#Mode">IIterationSimulationState.Mode</h4>
  <div class="markdown level1 summary"><p>Gets the iteration mode.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">IterationModes IIterationSimulationState.Mode { get; }</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IterationModes.html">IterationModes</a></td>
        <td><p>The mode.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_SpiceSharp_Simulations_IIterationSimulationState_SourceFactor_" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.SpiceSharp#Simulations#IIterationSimulationState#SourceFactor*"></a>
  <h4 id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_SpiceSharp_Simulations_IIterationSimulationState_SourceFactor" data-uid="SpiceSharp.Components.ParallelComponents.Biasing.IterationSimulationState.SpiceSharp#Simulations#IIterationSimulationState#SourceFactor">IIterationSimulationState.SourceFactor</h4>
  <div class="markdown level1 summary"><p>The current source factor.
This parameter is changed when doing source stepping for aiding convergence.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">double IIterationSimulationState.SourceFactor { get; }</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="SpiceSharp_Components_ParallelComponents_Biasing_IterationSimulationState_SpiceSharp_Simulations_IIterationSimulationState_SourceFactor_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>In source stepping, all sources are considered to be at 0 which has typically only one single solution (all nodes and
currents are 0V and 0A). By increasing the source factor in small steps, it is possible to progressively reach a solution
without having non-convergence.</p>
</div>
  <h3 id="implements">Implements</h3>
  <div>
      <a class="xref" href="SpiceSharp.Simulations.IIterationSimulationState.html">IIterationSimulationState</a>
  </div>
  <div>
      <a class="xref" href="SpiceSharp.Simulations.ISimulationState.html">ISimulationState</a>
  </div>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="SpiceSharp.Utility.html#SpiceSharp_Utility_ThrowIfNull__1___0_System_String_">Utility.ThrowIfNull&lt;T&gt;(T, String)</a>
  </div>
  <h3 id="seealso">See Also</h3>
  <div class="seealso">
      <div><a class="xref" href="SpiceSharp.Simulations.IIterationSimulationState.html">IIterationSimulationState</a></div>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
